Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The axon identifier.

Body

application/json
metadata
object | null

User defined metadata to replace the axon metadata. Omit or set to null to leave unchanged, or set to an empty map to clear it.

Response

OK

id
string
required

The axon identifier.

created_at_ms
integer<int64>
required

Creation time in milliseconds since epoch.

metadata
object
required

The user defined axon metadata.

name
string | null

The name of the axon.

deleted_at_ms
integer<int64> | null

Deletion time in milliseconds since epoch; null while the axon is active.